<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Global</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Global</h1>

    




<section>

<header>
    
        <h2></h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        

        


<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>


        
    
    </div>

    

    

    

     

    

    
        <h3 class="subsection-title">Members</h3>

        
            
<h4 class="name" id="spsCodec"><span class="type-signature">(constant) </span>spsCodec<span class="type-signature"></span></h4>




<div class="description">
    NOW we are ready to build an SPS parser!
</div>







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="bit-streams_h264_seq-parameter-set.js.html">bit-streams/h264/seq-parameter-set.js</a>, <a href="bit-streams_h264_seq-parameter-set.js.html#line27">line 27</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id="start"><span class="type-signature">(constant) </span>start<span class="type-signature"></span></h4>




<div class="description">
    General ExpGolomb-Encoded-Structure Parse Functions
</div>







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="bit-streams_h264_lib_combinators.js.html">bit-streams/h264/lib/combinators.js</a>, <a href="bit-streams_h264_lib_combinators.js.html#line14">line 14</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
    

    
        <h3 class="subsection-title">Methods</h3>

        
            

    

    <h4 class="name" id="frameNumBits"><span class="type-signature"></span>frameNumBits<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Functions for calculating the number of bits to read for certain
properties based on the values in other properties (usually specified
in the SPS)
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="bit-streams_h264_slice-header.js.html">bit-streams/h264/slice-header.js</a>, <a href="bit-streams_h264_slice-header.js.html#line22">line 22</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="inspectMp4"><span class="type-signature"></span>inspectMp4<span class="signature">(data)</span><span class="type-signature"> &rarr; {array}</span></h4>

    



<div class="description">
    Return a javascript array of box objects parsed from an ISO base
media file.
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>data</code></td>
            

            <td class="type">
            
                
<span class="param-type">Uint8Array</span>


            
            </td>

            

            

            <td class="description last">the binary data of the media to be inspected</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="inspectors_mp4.js.html">inspectors/mp4.js</a>, <a href="inspectors_mp4.js.html#line699">line 699</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    a javascript array of potentially nested box objects
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">array</span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="parsePesPackets"><span class="type-signature"></span>parsePesPackets<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Reconsistutes program elementary stream (PES) packets from parsed
transport stream packets. That is, if you pipe an
mp2t.TransportParseStream into a mp2t.ElementaryStream, the output
events will be events which capture the bytes for individual PES
packets plus relevant metadata that has been extracted from the
container.
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="inspectors_ts.js.html">inspectors/ts.js</a>, <a href="inspectors_ts.js.html#line265">line 265</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="parseTransportStream"><span class="type-signature"></span>parseTransportStream<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Splits an incoming stream of binary data into MPEG-2 Transport
Stream packets.
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="inspectors_ts.js.html">inspectors/ts.js</a>, <a href="inspectors_ts.js.html#line19">line 19</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="parseTransportStreamPackets"><span class="type-signature"></span>parseTransportStreamPackets<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Accepts an MP2T TransportPacketStream and emits data events with parsed
forms of the individual transport stream packets.
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="inspectors_ts.js.html">inspectors/ts.js</a>, <a href="inspectors_ts.js.html#line83">line 83</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="parseType"><span class="type-signature"></span>parseType<span class="signature">(buffer)</span><span class="type-signature"> &rarr; {string}</span></h4>

    



<div class="description">
    Returns the string representation of an ASCII encoded four byte buffer.
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>buffer</code></td>
            

            <td class="type">
            
                
<span class="param-type">Uint8Array</span>


            
            </td>

            

            

            <td class="description last">a four-byte buffer to translate</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="inspectors_mp4.js.html">inspectors/mp4.js</a>, <a href="inspectors_mp4.js.html#line17">line 17</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    the corresponding string
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="textifyMp4"><span class="type-signature"></span>textifyMp4<span class="signature">(inspectedMp4, depth)</span><span class="type-signature"> &rarr; {string}</span></h4>

    



<div class="description">
    Returns a textual representation of the javascript represtentation
of an MP4 file. You can use it as an alternative to
JSON.stringify() to compare inspected MP4s.
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>inspectedMp4</code></td>
            

            <td class="type">
            
                
<span class="param-type">array</span>


            
            </td>

            

            

            <td class="description last">the parsed array of boxes in an MP4
file</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>depth</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">(optional) the number of ancestor boxes of
the elements of inspectedMp4. Assumed to be zero if unspecified.</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="inspectors_mp4.js.html">inspectors/mp4.js</a>, <a href="inspectors_mp4.js.html#line769">line 769</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    a text representation of the parsed MP4
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    



        
    

    

    
</article>

</section>




</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#frameNumBits">frameNumBits</a></li><li><a href="global.html#inspectMp4">inspectMp4</a></li><li><a href="global.html#parsePesPackets">parsePesPackets</a></li><li><a href="global.html#parseTransportStream">parseTransportStream</a></li><li><a href="global.html#parseTransportStreamPackets">parseTransportStreamPackets</a></li><li><a href="global.html#parseType">parseType</a></li><li><a href="global.html#spsCodec">spsCodec</a></li><li><a href="global.html#start">start</a></li><li><a href="global.html#textifyMp4">textifyMp4</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.2</a> on Wed Oct 19 2016 14:31:22 GMT-0400 (EDT)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>